gridpack::utility::Configurable Class Reference

#include <configurable.hpp>

Inheritance diagram for gridpack::utility::Configurable:

[legend]

Collaboration diagram for gridpack::utility::Configurable:

[legend]

List of all members.

Public Member Functions
	Configurable (const Configurable &old)
	Copy constructor.
	~Configurable (void)
	Destructor.
std::string	configurationKey (void) const
	Get this instance's configuration key.
void	configurationKey (const std::string &s)
	Set this instance's configuration key.
bool	isConfigured (void) const
	Is this instance configured?
void	configure (utility::Configuration::CursorPtr theprops)
	Initialize this instance using the specified configuration property tree.

---

Detailed Description

This serves as the base for any class that has run-time options that are read from the globally available Configuration database. An instance of this class is assumed to have a uniquely key which identifies its part of the Configuration option tree.

---

Constructor & Destructor Documentation

gridpack::utility::Configurable::Configurable

(

const Configurable &

old

)

Copy constructor.

gridpack::utility::Configurable::~Configurable

(

void

)

Destructor.

---

Member Function Documentation

void gridpack::utility::Configurable::configurationKey

(

const std::string &

s

)

[virtual]

Set this instance's configuration key.

Implements gridpack::utility::ConfigurableInterface.

std::string gridpack::utility::Configurable::configurationKey

(

void

)

const [virtual]

Get this instance's configuration key.

Implements gridpack::utility::ConfigurableInterface.

void gridpack::utility::Configurable::configure

(

utility::Configuration::CursorPtr

theprops

)

[virtual]

Initialize this instance using the specified configuration property tree.

Implements gridpack::utility::ConfigurableInterface.

bool gridpack::utility::Configurable::isConfigured

(

void

)

const [virtual]

Is this instance configured?

Implements gridpack::utility::ConfigurableInterface.

---

The documentation for this class was generated from the following file:

• configurable.hpp